/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui;

import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;

import javax.swing.JFrame;

import net.sf.freecol.client.FreeColClient;


/**
 * The WindowListener for the FullScreenFrame class.
 */
public final class FullScreenFrameListener implements WindowListener
{

    private final FreeColClient freeColClient;
    private final FreeColFrame frame;

    /**
     * Constructs this WindowListener.
     *
     * @param freeColClient The <code>FreeColClient</code> to notify.
     * @param frame The frame.
     */
    public FullScreenFrameListener( FreeColClient freeColClient,
                                    FreeColFrame frame )
    {
        this.freeColClient = freeColClient;
        this.frame = frame;
    }

    /**
     * Invoked when the window gets activated.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowActivated( WindowEvent event )
    {
    }

    /**
     * Invoked when the window gets closed.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowClosed( WindowEvent event )
    {
    }

    /**
     * Invoked when the window is closing.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowClosing( WindowEvent event )
    {
        if ( freeColClient.isInGame( ) )
        {
            freeColClient.askToQuit( );
        }
        else
        {
            freeColClient.quit( );
        }
    }

    /**
     * Invoked when the window gets deactivated.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowDeactivated( WindowEvent event )
    {
    }

    /**
     * Invoked when the window gets deiconified.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowDeiconified( WindowEvent event )
    {
    }

    /**
     * Invoked when the window gets iconified.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowIconified( WindowEvent event )
    {
        // Counter Java misbehaviour of minimizing JFrame when opening JDialog,
        // causing bug #2729. Sadly, it may take a split second.
        // See https://bugs.openjdk.java.net/browse/JDK-6770428
        // TODO: Don't just hide the symptom, prevent hitting the trigger.
        // TODO: Minimize side effect of also undoing Alt+Tab and similar,
        // if there are complaints. Maybe remember number of open dialogs
        // and/or time since using one, then test for it here.
        frame.setExtendedState( JFrame.NORMAL );
    }

    /**
     * Invoked when the window gets opened.
     *
     * @param event The event that has information on the action.
     */
    @Override
    public void windowOpened( WindowEvent event )
    {
    }
}
